/**
 * @copyright
 * Copyright (C) 2020 Assured Information Security, Inc.
 *
 * @copyright
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * @copyright
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * @copyright
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#ifndef ALLOC_AND_COPY_MK_ELF_FILE_FROM_USER_H
#define ALLOC_AND_COPY_MK_ELF_FILE_FROM_USER_H

#include <elf_file_t.h>
#include <span_t.h>
#include <types.h>

#ifdef __cplusplus
extern "C"
{
#endif

    /**
     * <!-- description -->
     *   @brief When the start VMM function is executed, the user must provide
     *     the address and size of the microkernel ELF file to be loaded and
     *     executed. This ELF file exists in user-space memory and cannot be
     *     directly accessed. As a result, we must copy this array from user
     *     space into a array in the kernel where the loader exists. This
     *     function performs this copy by first allocating a array the size
     *     of the ELF file being copied and then copies the contents to this
     *     newly allocated array. For this reason, once this ELF file is no
     *     longer needed, you must free the ELF file as memory was previously
     *     allocated.
     *
     * <!-- inputs/outputs -->
     *   @param mk_elf_file_from_user the ELF file to copy
     *   @param pmut_copied_mk_elf_file where to copy the ELF file too
     *   @return LOADER_SUCCESS on success, LOADER_FAILURE on failure.
     */
    NODISCARD int64_t alloc_and_copy_mk_elf_file_from_user(
        struct span_t const *const mk_elf_file_from_user,
        struct elf_file_t *const pmut_copied_mk_elf_file) NOEXCEPT;

#ifdef __cplusplus
}
#endif

#endif
